define({ "api": [
  {
    "group": "商品信息",
    "type": "get",
    "url": "/api/goods/detail",
    "title": "获取商品详情数据",
    "version": "0.0.0",
    "description": "<p>获取商品详情数据</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "id",
            "description": "<p>商品编号</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"请求成功\",\n   \"data\":{}\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Error 4xx",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Error 4xx",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Error-Response:",
          "content": "{\n   \"code\":201,\n   \"title\":\"请求失败\",\n   \"data\":\"NOT DATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/goods/detail"
      }
    ],
    "filename": "api/goods.js",
    "groupTitle": "商品信息",
    "name": "GetApiGoodsDetail"
  },
  {
    "group": "商品信息",
    "type": "get",
    "url": "/api/goods/get",
    "title": "获取商品数据",
    "version": "0.0.0",
    "description": "<p>获取商品数据</p>",
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"请求成功\",\n   \"data\":[{},{},...]\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Error 4xx",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Error 4xx",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Error-Response:",
          "content": "{\n   \"code\":201,\n   \"title\":\"请求失败\",\n   \"data\":\"NOT DATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/goods/get"
      }
    ],
    "filename": "api/goods.js",
    "groupTitle": "商品信息",
    "name": "GetApiGoodsGet"
  },
  {
    "group": "商品信息",
    "type": "get",
    "url": "/api/goods/sort",
    "title": "获取商品排序数据",
    "version": "0.0.0",
    "description": "<p>根据指定字段，获取商品排序数据</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "sortKey",
            "description": "<p>要排序的字段</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "direct",
            "description": "<p>1为升序，-1为降序</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"请求成功\",\n   \"data\":[{},{},...]\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Error 4xx",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Error 4xx",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Error-Response:",
          "content": "{\n   \"code\":201,\n   \"title\":\"请求失败\",\n   \"data\":\"NOT DATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/goods/sort"
      }
    ],
    "filename": "api/goods.js",
    "groupTitle": "商品信息",
    "name": "GetApiGoodsSort"
  },
  {
    "group": "用户信息",
    "type": "post",
    "url": "/api/user/getUser",
    "title": "获取用户信息",
    "version": "0.0.0",
    "description": "<p>根据 登录成功之后的token获取用户信息</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "token",
            "description": "<p>token</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"获取成功\",\n   \"data\":{用户数据},\n   \"token\":{解析之后的token内容}\n}\n{\n   \"code\":201,\n   \"title\":\"登录失效\",\n   \"data\":{token解析失败之后的内容}\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/user/getUser"
      }
    ],
    "filename": "api/user.js",
    "groupTitle": "用户信息",
    "name": "PostApiUserGetuser"
  },
  {
    "group": "用户信息",
    "type": "post",
    "url": "/api/user/login",
    "title": "用户登录",
    "version": "0.0.0",
    "description": "<p>根据 用户名+密码 或 手机号+密码 登录，注意，用户名和手机号有且只有一个即可</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "username",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "tel",
            "description": "<p>手机号</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "password",
            "description": "<p>密码</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"登录成功\",\n   \"data\":\"用户id\",\n   \"token\":\"登录成功后的token\"\n}\n{\n   \"code\":201,\n   \"title\":\"用户名或手机号未注册\",\n   \"data\":\"NOTDATA\"\n}\n{\n   \"code\":202,\n   \"title\":\"密码不对\",\n   \"data\":\"NOTDATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/user/login"
      }
    ],
    "filename": "api/user.js",
    "groupTitle": "用户信息",
    "name": "PostApiUserLogin"
  },
  {
    "group": "用户信息",
    "type": "post",
    "url": "/api/user/register",
    "title": "用户注册",
    "version": "0.0.0",
    "description": "<p>根据用户名+手机号+密码注册账号</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "username",
            "description": "<p>用户名</p>"
          },
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "password",
            "description": "<p>密码</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "tel",
            "description": "<p>手机号</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "code",
            "description": "<p>短信验证码</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"注册成功\",\n   \"data\":\"用户id\"\n}\n{\n   \"code\":201,\n   \"title\":\"用户名重复\",\n   \"data\":\"NOTDATA\"\n}\n{\n   \"code\":202,\n   \"title\":\"请先发送短信验证码\",\n   \"data\":\"NOTDATA\"\n}\n{\n   \"code\":203,\n   \"title\":\"一个手机号只能注册一个用户名\",\n   \"data\":\"NOTDATA\"\n}\n{\n   \"code\":204,\n   \"title\":\"验证码不对\",\n   \"data\":\"NOTDATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/user/register"
      }
    ],
    "filename": "api/user.js",
    "groupTitle": "用户信息",
    "name": "PostApiUserRegister"
  },
  {
    "group": "用户信息",
    "type": "post",
    "url": "/api/user/send",
    "title": "发送短信验证码",
    "version": "0.0.0",
    "description": "<p>根据手机号发送短信验证码</p>",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "tel",
            "description": "<p>手机号</p>"
          }
        ]
      }
    },
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"请求成功\",\n   \"data\":成功信息\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Error 4xx",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Error 4xx",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Error-Response:",
          "content": "{\n   \"code\":201,\n   \"title\":\"请求失败\",\n   \"data\":报错信息\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/user/send"
      }
    ],
    "filename": "api/user.js",
    "groupTitle": "用户信息",
    "name": "PostApiUserSend"
  },
  {
    "group": "轮播图信息",
    "type": "get",
    "url": "/api/banner/get",
    "title": "获取轮播图数据",
    "version": "0.0.0",
    "description": "<p>获取轮播图数据</p>",
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Success 200",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Success 200",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Success-Response:",
          "content": "{\n   \"code\":200,\n   \"title\":\"请求成功\",\n   \"data\":[{},{},...]\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "type": "number",
            "optional": false,
            "field": "code",
            "description": "<p>请求状态</p>"
          },
          {
            "group": "Error 4xx",
            "type": "string",
            "optional": false,
            "field": "title",
            "description": "<p>请求说明</p>"
          },
          {
            "group": "Error 4xx",
            "type": "array",
            "optional": false,
            "field": "data",
            "description": "<p>请求数据</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Error-Response:",
          "content": "{\n   \"code\":201,\n   \"title\":\"请求失败\",\n   \"data\":\"NOT DATA\"\n}",
          "type": "json"
        }
      ]
    },
    "sampleRequest": [
      {
        "url": "http://localhost:3000/api/banner/get"
      }
    ],
    "filename": "api/banner.js",
    "groupTitle": "轮播图信息",
    "name": "GetApiBannerGet"
  }
] });
